Skip to main content

Create Delivery Order

POST /tms/delivery-orders

Description​

This endpoint is used to create a new delivery order. It involves providing details about the pickup and drop-off locations, items being delivered, and various other parameters necessary to process the order.

Parameters​

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The country code for the delivery location.

Request Body​

  • Media Type: application/json

Example Value​

{
  "shippingFeeRequestId": "string",
  "orderReference": "string",
  "pickupLocation": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "userId": "string",
    "city": "string"
  },
  "dropOffLocation": {
    "latitude": 0,
    "longitude": 0,
    "address": "string",
    "userId": "string",
    "city": "string"
  },
  "dropOffContact": "string",
  "pickupContact": "string",
  "pickupEmail": "string",
  "dropOffEmail": "string",
  "shippingFee": 0,
  "items": [
    {
      "name": "string",
      "paid": true,
      "price": 1,
      "quantity": 1,
      "weight": 0,
      "imageUrl": "string"
    }
  ],
  "clientId": "string",
  "serviceType": "string",
  "paymentMode": "string",
  "numberOfAssets": 0,
  "serviceCharge": 0,
  "asset": "string",
  "orderCapacity": 0,
  "deliveryAssistants": [
    {
      "name": "string",
      "fee": 0
    }
  ],
  "paymentMethod": "string",
  "userId": "string",
  "clientInvoiceImageUrl": "string",
  "cargoType": "string",
  "invoiceNumber": "string",
  "businessId": "string",
  "amountPaid": 0,
  "source": "SABI_MARKET"
}

Responses​

201 Created​

Description: The delivery order was successfully created. Media Type: Controls Accept header.

Example Value​

{
  "status": true,
  "statusCode": 0,
  "message": "Delivery order created successfully",
  "data": {},
  "errors": []
}

400 Bad Request​

Description: The request was invalid. Media Type: Controls Accept header.

Example Value​

{
  "status": false,
  "statusCode": 400,
  "message": "Invalid request",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request POST \ 
 --url  /tms/delivery-orders \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!